Package io.realm.kotlin.mongodb.sync

Types

BaseSubscriptionSet

interface BaseSubscriptionSet : Iterable<Subscription>

Base interface for shared functionality between SubscriptionSet and MutableSubscriptionSet.

ConnectionState

enum ConnectionState : Enum<ConnectionState>

A connection state indicates the state of the underlying connection of the SyncSession.

ConnectionStateChange

data class ConnectionStateChange(oldState: ConnectionState, newState: ConnectionState)

A connection state change indicates a change in the SyncSession's underlying connection state.

Direction

enum Direction : Enum<Direction>

A direction indicates whether a given Progress-flow created with SyncSession.progressAsFlow is reporting changes when either uploading or downloading data.

DiscardUnsyncedChangesStrategy

interface DiscardUnsyncedChangesStrategy : SyncClientResetStrategy

Strategy that automatically resolves a Client Reset by discarding any unsynced local data but otherwise keeps the realm open.

InitialRemoteDataConfiguration

data class InitialRemoteDataConfiguration(timeout: Duration)

Configuration options if SyncConfiguration.Builder.waitForInitialRemoteData is enabled.

InitialSubscriptionsCallback

fun fun interface InitialSubscriptionsCallback

Callback used to populate the initial SubscriptionSet when opening a Realm.

InitialSubscriptionsConfiguration

data class InitialSubscriptionsConfiguration(callback: InitialSubscriptionsCallback, rerunOnOpen: Boolean)

Configuration options if SyncConfiguration.Builder.initialSubscriptions is enabled.

ManuallyRecoverUnsyncedChangesStrategy

interface ManuallyRecoverUnsyncedChangesStrategy : SyncClientResetStrategy

Strategy to manually resolve a Client Reset.

MutableSubscriptionSet

interface MutableSubscriptionSet : BaseSubscriptionSet

A mutable subscription set makes it possible to add, remove or modify a SubscriptionSet.

Progress

data class Progress(transferredBytes: ULong, transferableBytes: ULong)

A progress indicator emitted by flows created from SyncSession.progressAsFlow.

ProgressMode

enum ProgressMode : Enum<ProgressMode>

A progress mode is used to select which notifications are received from SyncSession.progressAsFlow.

Subscription

interface Subscription

A subscription defines a specific server query and its metadata.

SubscriptionSet

interface SubscriptionSet<T : BaseRealm> : BaseSubscriptionSet

A subscription set is an immutable view of all current Subscriptions for a given Realm that has been configured for Flexible Sync.

SubscriptionSetState

enum SubscriptionSetState : Enum<SubscriptionSetState>

The possible states a SubscriptionSet or MutableSubscriptionSet can be in.

SyncClientResetStrategy

interface SyncClientResetStrategy

Interface that defines a generic sync client reset strategy.

SyncConfiguration

interface SyncConfiguration : Configuration

A SyncConfiguration is used to setup a Realm Database that can be synchronized between devices using Atlas Device Sync.

SyncMode

enum SyncMode : Enum<SyncMode>

This enum determines how Realm sync data with the server.

SyncSession

interface SyncSession

A session controls how data is synchronized between a single Realm on the device and MongoDB on the server.

Functions

asQuery

inline fun <T : RealmObject> Subscription.asQuery(): RealmQuery<T>

Converts the Subscription.queryDescription back to a RealmQuery that can be executed against the local Realm.